/*
 * Copyright (c) 2009-2010, Dennis Wang (dennis.wangkk@gmail.com)
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the University of California, Berkeley nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*!
 \file proxy.hpp
 \brief the proxy of instance
 */

#ifndef proxy_hpp
#define proxy_hpp

#include <string>

#include "observer.hpp"
#include "instance.hpp"

/*!
 \brief the proxy of instance
 */

class Proxy : public Observer {
public:

    /*!
     \brief constructor
     \param instanceID_ instance ID
     \param pluginName_ plugin name
     \param source_ is a source?
     */

    Proxy (int instanceID_, const std::string& pluginName_,
        bool source_ = false) 
        : _instanceID (instanceID_),
          _pluginName (pluginName_),
          _source (source_) {}

    /*!
     \brief destructor
     */

    virtual ~Proxy () {}

    /*!
     \brief get the instance ID
     \return the instance ID
     */

    inline int getInstanceID () { return _instanceID; }

    /*!
     \brief get the plugin name
     \return plugin name
     */

    inline const std::string& getPluginName () {
        return _pluginName;
    }

    /*!
     \brief get source flag
     \return source flag
     */

    inline bool getSource () {
        return _source;
    }

private:
    int         _instanceID; ///< instance ID
    bool        _source;     ///< source flag
    std::string _pluginName; ///< plugin name
};

#endif // proxy_hpp
